home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / engrave / Engrave.h < prev   
C/C++ Source or Header  |  2006-01-09  |  2KB  |  99 lines
  1. #ifndef ENGRAVE_H
  2. #define ENGRAVE_H
  3.  
  4. /**
  5.  * @file Engrave.h
  6.  * @brief The file that should be included by any project using Engrave.
  7.  * It provides all the necessary headers and includes to work with Engrave.
  8.  */
  9.  
  10. /**
  11.  * @mainpage Engrave Library Documentation
  12.  *
  13.  * @image html e_mini.png
  14.  *
  15.  * @section intro Introduction
  16.  *
  17.  * Engrave is a designed to allow you the ability to easily create and edit
  18.  * Edje EDJ files.
  19.  *
  20.  * As an example of how easy Engrave is to work with, the following example
  21.  * will read in either an EDC file or an EDJ file and attempt to write out
  22.  * an EDJ and EDC version of the given file.
  23.  *
  24.  * @code
  25.  * #include "Engrave.h"
  26.  * 
  27.  * int
  28.  * main(int argc, char ** argv)
  29.  * {
  30.  *     Engrave_File *ef = NULL;
  31.  *
  32.  *     if (argc < 2) {
  33.  *         printf("need file\n");
  34.  *         return 1;
  35.  *     }
  36.  *
  37.  *     if (strstr(argv[1], ".edj"))
  38.  *         ef = engrave_load_edj(argv[1]);
  39.  *     else {
  40.  *         if (argc < 4) {
  41.  *             printf("need img and font dirs with .edc file\n");
  42.  *             return 1;
  43.  *         }
  44.  *         ef = engrave_load_edc(argv[1], argv[2], argv[3]);
  45.  *     }
  46.  * 
  47.  *     if (!engrave_edj_output(ef, "test.edj"))
  48.  *         printf("failed to write test.edj\n");
  49.  * 
  50.  *     if (!engrave_edc_output(ef, "test.out"))
  51.  *         printf("failed to write test.out\n"); 
  52.  *
  53.  *     return 0;
  54.  * }
  55.  * @endcode
  56.  *
  57.  * Compiling with the Engrave library is pretty simple, assuming you've
  58.  * named your app engrave_test.c the following command will do the trick:
  59.  *
  60.  * @code
  61.  * gcc -o engrave_test `engrave-config --cflags --libs` engrave_test.c
  62.  * @endcode
  63.  *
  64.  * @section Conclusion
  65.  * Engrave has been designed to make it easy to open and maniuplate Edje
  66.  * files, be they EDJ or EDC.
  67.  *
  68.  * If you have any questions or comments about Engrave please email
  69.  * dj2 <zero@perplexity.org> or Rephorm <rephorm@rephorm.com>
  70.  *
  71.  */
  72.  
  73. #ifdef __cplusplus
  74. extern "C" {
  75. #endif
  76.  
  77. #include <Evas.h>
  78.  
  79. #include <engrave_enums.h>
  80. #include <engrave_data.h>
  81. #include <engrave_image.h>
  82. #include <engrave_font.h>
  83. #include <engrave_program.h>
  84. #include <engrave_part_state.h>
  85. #include <engrave_part.h>
  86. #include <engrave_group.h>
  87. #include <engrave_file.h>
  88.  
  89. #include <engrave_load.h>
  90. #include <engrave_out.h>
  91.  
  92. #include <engrave_canvas.h>
  93.  
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #endif
  98.  
  99.